<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: capnp Namespace Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Public API.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">capnp Namespace Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Small group of miscellaneous utilities to ease work with capnp (Cap'n Proto), joining its <code>capnp</code> namespace.  
<a href="namespacecapnp.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8ce2ee1369a8ff7c8bd2ea75ca8af067"><td class="memItemLeft" align="right" valign="top">std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacecapnp.html#a8ce2ee1369a8ff7c8bd2ea75ca8af067">operator&lt;&lt;</a> (std::ostream &amp;os, const Text::Reader &amp;val)</td></tr>
<tr class="memdesc:a8ce2ee1369a8ff7c8bd2ea75ca8af067"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints string representation of the given <code>capnp::Text::Reader</code> to the given <code>ostream</code>.  <a href="namespacecapnp.html#a8ce2ee1369a8ff7c8bd2ea75ca8af067">More...</a><br /></td></tr>
<tr class="separator:a8ce2ee1369a8ff7c8bd2ea75ca8af067"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Small group of miscellaneous utilities to ease work with capnp (Cap'n Proto), joining its <code>capnp</code> namespace. </p>
<p >As of this writing circumstances have to very particular and rare indeed for something to actually be added by us to this namespace. As I write this, it contains only <code>oparator&lt;&lt;(std::ostream&amp;, capnp::Text::Reader&amp;)</code>. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a8ce2ee1369a8ff7c8bd2ea75ca8af067" name="a8ce2ee1369a8ff7c8bd2ea75ca8af067"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ce2ee1369a8ff7c8bd2ea75ca8af067">&#9670;&nbsp;</a></span>operator&lt;&lt;()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::ostream &amp; capnp::operator&lt;&lt; </td>
          <td>(</td>
          <td class="paramtype">std::ostream &amp;&#160;</td>
          <td class="paramname"><em>os</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const Text::Reader &amp;&#160;</td>
          <td class="paramname"><em>val</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Prints string representation of the given <code>capnp::Text::Reader</code> to the given <code>ostream</code>. </p>
<h3>Rationale for existence</h3>
<p >Well, capnp does not provide it, even though it provides a conversion operator to <code>string</code> and such; and it's nice to be able to print these (particularly when logging with <code>FLOW_LOG_*()</code>). For whatever reason the auto-conversion operator does not "kick in" when placed in a an <code>ostream&lt;&lt;</code> context; so such printing does not compile (nor does <code>lexical_cast&lt;string&gt;</code>).</p>
<p >It won't be forced on anyone that doesn't include the present detail/ header.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">os</td><td>Stream to which to write. </td></tr>
    <tr><td class="paramname">val</td><td>Object to serialize. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>os</code>. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:23 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
